You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2, because the PR involves a straightforward addition of a GitHub Actions workflow for marking stale issues and PRs. The configuration is simple and follows standard practices for such workflows.
🧪 Relevant tests
No
🔍 Possible issues
Possible Bug: The cron schedule '14 29 * * *' seems incorrect. Cron syntax for minutes should be from 0 to 59. The current setting might not trigger the action as expected.
🔒 Security concerns
No
Code feedback:
relevant file
.github/workflows/stale.yml
suggestion
Correct the cron schedule syntax to ensure the action triggers correctly. For example, if you want it to run daily at 00:29, use '29 0 * * *'. [important]
Consider increasing the 'days-before-stale' for issues to give more time for response. Setting it to 1 day might be too aggressive. Suggesting 30 days as a more reasonable default. [medium]
Add a step to check out the repository using 'actions/checkout@v2' before running the stale action. This ensures that all necessary repository data is available for the action. [medium]
Add an 'exempt-issue-labels' and 'exempt-pr-labels' option to prevent marking certain important issues or PRs as stale, such as those labeled 'priority'. [medium]
Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.
The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
Improve the clarity and informativeness of stale messages.
Consider using a more descriptive and specific message for stale issues and pull requests. This helps contributors understand why their issue or PR was marked as stale and what they can do to reactivate it.
-stale-issue-message: 'Stale issue message'-stale-pr-message: 'Stale pull request message'+stale-issue-message: 'This issue has been inactive for a while. Add a comment or make an update to keep it open!'+stale-pr-message: 'This pull request has not been updated recently. Please update it soon, or it will be closed.'
Extend the time before issues are marked as stale to be more accommodating.
Increase the days-before-stale for issues to give contributors more time to respond. One day is quite aggressive and might not be enough for many contributors to react, especially those in different time zones or with less frequent GitHub activity.
-days-before-stale: 1+days-before-stale: 14 # Two weeks before marking as stale
Add exemptions for certain labels to avoid marking important issues and PRs as stale.
Add an exempt-issue-labels and exempt-pr-labels option to prevent marking certain important or critical issues and PRs as stale. This can help maintain focus on key areas without being disrupted by the stale bot.
Optimize the timing of the stale workflow execution.
Adjust the cron schedule to a more typical time, such as early morning or late evening, to minimize disruption during active hours. The current setting might trigger during peak activity times for some contributors.
-- cron: '14 29 * * *'+- cron: '0 2 * * *' # Runs at 2 AM UTC
Define actions upon closing stale issues and PRs for better management and transparency.
Specify an action to take when issues or PRs are closed due to inactivity, such as adding a label or commenting. This can provide a clear audit trail and help in managing post-closure activities.
days-before-pr-close: 7
+close-issue-label: 'closed-inactive'+close-pr-comment: 'This PR has been closed due to inactivity. Please reopen it if you wish to continue working on it.'
✨ Improve tool usage guide:
Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
For internal users - Please add a Jira DX PR ticket to the subject!
Preview Link
Description
Screenshots (if appropriate)
Checklist
master.Type
enhancement
Description
Changes walkthrough
stale.yml
Add GitHub Action for Stale Issues and PRs.github/workflows/stale.yml